.TH MSTREG "1" "March 2020" "mstflint" "User Commands"
.SH NAME
mstreg \- Expose supported access registers
.SH DESCRIPTION
.IP
NAME:
.IP
mstreg
.IP
SYNOPSIS:
.IP
mstreg [OPTIONS]
.IP
DESCRIPTION:
.IP
Exposes supported access registers, and allows users to obtain information regarding
the registers fields and attributes, and to set and get data with specific
register.
.IP
OPTIONS:
.TP
\fB\-h\fR |\-\-help
: Display help message.
.TP
\fB\-v\fR |\-\-version
: Display version info.
.TP
\fB\-d\fR |\-\-device
<device>               : Perform operation for a specified mst device.
.TP
\fB\-a\fR |\-\-adb_file
<adb_file>             : An external ADB file
.TP
\fB\-\-reg_name\fR
<reg_name>             : Known access register name
.TP
\fB\-\-reg_id\fR
<reg_ID>               : Access register ID
.TP
\fB\-\-reg_len\fR
<reg_length>           : Access register layout length (bytes)
.TP
\fB\-i\fR |\-\-indexes
<idxs_vals>            : Register indexes
.TP
\fB\-g\fR |\-\-get
: Register access GET
.TP
\fB\-s\fR |\-\-set
<reg_dataStr>          : Register access SET
.TP
\fB\-\-show_reg\fR
<reg_name>             : Print the fields of a given reg access (must have reg_name)
.TP
\fB\-\-show_regs\fR
: Print all available reg access'
.TP
\fB\-\-yes\fR
: Non\-interactive mode, answer yes to all questions
.IP
Examples:
.TP
Show all available access register
: mstreg \fB\-d\fR <device> \fB\-\-show_regs\fR
.TP
Show all fields of register PAOS
: mstreg \fB\-d\fR <device> \fB\-\-show_reg\fR PAOS
.IP
GET PAOS with indexes: local port 0x1 and swid 0x5:
.IP
mstreg \fB\-d\fR <device> \fB\-\-get\fR \fB\-\-reg_name\fR PAOS \fB\-\-indexes\fR "local_port=0x1,swid=0x5"
.IP
SET PAOS with indexes: local port 0x1 and swid 0x5, and data: e 0x0:
.IP
mstreg \fB\-d\fR <device> \fB\-\-set\fR "e=0x0" \fB\-\-reg_name\fR PAOS \fB\-\-indexes\fR "local_port=0x1,swid=0x5"
.SH "SEE ALSO"
.B mstflint(1)
